Refactor the project cracker into a new file et al. #618

teo-tsirpanis · 2020-10-18T09:56:49Z

This PR:

Reduces the size of BuildCommand.fs by moving the project cracker in a file called ProjectCracker.fs.
Fixes The command tool does not correctly parse custom substitution parameters #617 by correctly grouping the arguments for the command's tool --parameters option and document how to use that command.
Makes the command tool stop reporting non-existent substitution parameters (they used to be reported as fsdocs-repository-link --> {{fsdocs-repository-link}}).
Removes the command tool's dependency to Newtonsoft.Json in favor of System.Text.Json in the documentation search index serializer.
Updates the packages, decluttering paket.lock.
Removes unnecessary code and optimizes performance in acouple of other cases.

Do not report nonexistent substitution parameters (see changes in the param function of ProjectCracker.fs).

Seq.pairwise [1;2;3;4] returns [1,2; 2,3; 3,4], not [1,2; 3,4].

And use Process.Start with UseShellExecute on all platforms (it is implemented on .NET Core).

Remove duplicate code in a helper function in BuildCommand.fs.

The most important is the replacement of the tree-based FSharpMap with the hashtable-based readOnlyDict.

…ined.

…e thrown. It is not needed. They will already be reported to the console and AggregateExceptions are not correctly handled.

src/FSharp.Formatting.CommandTool/Options.fs

wallymathieu · 2020-10-24T09:00:57Z

src/FSharp.Formatting.CommandTool/BuildCommand.fs

-                    if this.strict then exit 1
-                    false
+            with ex ->
+                Log.errorf "received exception :\n %A" ex


Doesn't seem to be any different logic related to aggregate exceptions 👍

src/FSharp.Formatting.CommandTool/ProjectCracker.fs

teo-tsirpanis added 8 commits October 16, 2020 12:50

Move some code from BuildCommand.fs to a new file.

80bd168

Do not report nonexistent substitution parameters (see changes in the param function of ProjectCracker.fs).

Fix and document the --parameters command line option.

715dd34

Seq.pairwise [1;2;3;4] returns [1,2; 2,3; 3,4], not [1,2; 3,4].

Remove a try-with block around File.Exists (it doesn't throw).

45eb0f9

And use Process.Start with UseShellExecute on all platforms (it is implemented on .NET Core).

Use System.Text.Json to serialize the documentation search index.

2ac7199

Remove duplicate code in a helper function in BuildCommand.fs.

Update packages.

90cacd2

Make some optimizations in the project cracker.

81b5b4e

The most important is the replacement of the tree-based FSharpMap with the hashtable-based readOnlyDict.

Exit without leaving a stacktrace if --parameters was incorrectly def…

e684ea1

…ined.

Do not catch and then print exceptions at the entry point; let them b…

0b2a1e3

…e thrown. It is not needed. They will already be reported to the console and AggregateExceptions are not correctly handled.

wallymathieu reviewed Oct 24, 2020

View reviewed changes

dsyme approved these changes Oct 24, 2020

View reviewed changes

dsyme merged commit f523d4c into fsprojects:master Oct 24, 2020

dsyme reviewed Oct 24, 2020

View reviewed changes

src/FSharp.Formatting.CommandTool/ProjectCracker.fs Show resolved Hide resolved

dsyme mentioned this pull request Oct 24, 2020

Retry project cracking when there isn't a targetPath #613

Merged

teo-tsirpanis deleted the patch-1 branch October 25, 2020 16:37

teo-tsirpanis restored the patch-1 branch April 16, 2021 16:27

teo-tsirpanis deleted the patch-1 branch January 16, 2023 23:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor the project cracker into a new file et al. #618

Refactor the project cracker into a new file et al. #618

teo-tsirpanis commented Oct 18, 2020 •

edited

Loading

wallymathieu Oct 24, 2020

Refactor the project cracker into a new file et al. #618

Refactor the project cracker into a new file et al. #618

Conversation

teo-tsirpanis commented Oct 18, 2020 • edited Loading

wallymathieu Oct 24, 2020

Choose a reason for hiding this comment

teo-tsirpanis commented Oct 18, 2020 •

edited

Loading